Skip to content

docs: add AGENTS.md contributor guide for AI agents#369

Open
ethanndickson wants to merge 3 commits into
mainfrom
docs/add-agents-md
Open

docs: add AGENTS.md contributor guide for AI agents#369
ethanndickson wants to merge 3 commits into
mainfrom
docs/add-agents-md

Conversation

@ethanndickson

Copy link
Copy Markdown
Member

Adds an AGENTS.md contributor guide at the repo root to give AI coding agents the high-signal context they need to work in this provider safely.

The document captures the provider's framework idioms (terraform-plugin-framework, not SDKv2), the resource file layout, essential make commands, and — most importantly — the project-specific patterns and anti-patterns distilled from past fixes (e.g. handling unknown values at plan/validate time, refreshing cached entitlements after a license apply, not stripping cty sensitivity marks in plan modifiers, and avoiding defer inside retry loops). Each anti-pattern references the PR/issue it was learned from.

Contents were verified against the current tree: Makefile targets, the util.go helpers, provider.go entitlement plumbing, the CI Terraform 1.01.9 acceptance matrix, and the golangci paralleltest config.

@ethanndickson ethanndickson self-assigned this Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant